2.1.2. Querry string parametrs

Parametrs

Parameter	Description	Mandatory	Type	Notes
obj	Organization		array
shop	Shop		array
device	Device		array
terminal	Terminal		array

obj Array Structure

Parameter	Description	Mandatory	Type	Notes
callback_url	URL for response callback
name	Organization name	required	string
fiscal_id	Tax number	required	string
is_legal	Legal entity flag		boolean	default True
contract_num	Contract number		string
contact_name	Contact person		string
region	Region name		string
city	City name		string
district	District name		string
address	Organization address		string
email	Email		string
phone	Organization phone number		string
activities	Array of activities	required	array

activities Array Structure

Parameter	Description	Mandatory	Type	Notes
code	Activity code	required
name	Activity name

shop Array Structure

Parameter	Description	Mandatory	Type	Notes
shop_name	Shop name	required	string	required, key if code not used
shop_address	Shop address	required	string
shop_phone	Shop phone number		string
shop_code	Shop code		string	key if used
shop_type	Shop type		string

device Array Structure

Parameter	Description	Mandatory	Type	Notes
dev_model	Device model		string	Possible values: “Smart One Bank Pro”, “Smart One Bank”
serial	Serial number		string
token	Fiscal token number		string
activated_packages	Array of activated packages		array

activated_packages Array Structure

Parameter	Description	Mandatory	Type	Notes
date_from	Start date	required
date_for	End date
code	Package type code	required		Possible values: “payment”, “payment_fiscal”, “payment_fiscal_payment”
terminal_id	Additional parameter for Payment
secret_key	Additional parameter for Payment

terminal Array Structure

Parameter	Description	Mandatory	Type	Notes
tid	Terminal UID	required	string
template_name	Terminal template name	required	string	Value “TBC Base”
processing_name	Processing name	required	string	Value “Compass+ TPTP”
mid	Organization UID	required	string	If not found, will be added
mcc	Organization category code	required	string
rs	Organization standard	required	string

Code structure

{
  "obj": { // Organization
    "callback_url": "URL for response callback", // string
    "name": "Organization name", // required, string
    "fiscal_id": "Tax number", // required, string
    "is_legal": "Legal entity flag", // boolean, default True
    "contract_num": "Contract number", // string
    "contact_name": "Contact person", // required, string
    "region": "Region name", // string
    "city": "City name", // string
    "district": "District name", // string
    "address": "Organization address", // string
    "email": "Email", // required, string
    "phone": "Organization phone number", // required, string
    "activities": [ // Array of activities, required
      {
        "code": "Activity code", // required
        "name": "Activity name" // optional
      }
    ]
  },
  "shop": { // Shop
    "shop_name": "Shop name", // required, key if code not used, string
    "shop_address": "Shop address", // required, string
    "shop_phone": "Shop phone number", // string
    "shop_code": "Shop code, key if used", // string
    "shop_type": "Shop type" // string
  },
  "device": { // Device
    "dev_model": "Device model", // string (possible values: “Smart One Bank Pro”, “Smart One Bank”)
    "serial": "Serial number", // string
    "token": "Fiscal token number", // string
    "activated_packages": [ // Array of activated packages, optional
      {
        "date_from": "Start date", // required
        "date_for": "End date",
        "code": "Package type code", // required (possible values: “payment”, “payment_fiscal”, “payment_fiscal_payme”)
        "terminal_id": "Additional parameter for Payme",
        "secret_key": "Additional parameter for Payme"
      }
    ]
  },
  "terminal": { // Terminal
    "tid": "Terminal UID", // required, string
    "template_name": "Terminal template name", // required, string (value “TBC Base”)
    "processing_name": "Processing name", // required, string (value “Compass+ TPTP”)
    "mid": "Organization UID", // required, string (if not found, will be added)
    "mcc": "Organization category code", // required, string
    "rs": "Organization standard", // optional, string
  }
}